Before installing apps on your Android payment terminals, you need to upload the app so we can convert it into a format that the terminals can handle. If an app also requires a certificate, you need to upload the certificate as well.
You can manually upload your apps and certificates in your Customer Area.You can also make API calls to schedule terminal actions that install your apps and certificates on your payment terminals.
By choosing to upload, install, or run any third-party applications on an Adyen payment terminal, you accept full responsibility and liability for any consequences of uploading, installing, or running any such applications.
Requirements
Before you begin, take into account the following requirements, limitations, and preparations.
Requirement | Description |
---|---|
Integration type | A point-of-sale integration with Adyen using Android payment terminals. |
API credentials | To upload apps and certificates using API requests, you must have an API credential with an API key and the following role:
If you have a Terminal API integration with cloud-based communications, you can use the existing API key that you use for Terminal API requests. |
Customer Area roles | To upload apps and certificates using the Customer Area, make sure that you have the following role:
|
Limitations | Requests to live Management API endpoints related to Android apps and certificates are subject to rate limits. |
Prepare the APK file
Before you upload apps to Adyen, you need to create a signed APK file of your app:
- In Android Studio, select Build > Generate Signed Bundle / APK.
- In the dialog, select APK and then Next.
- Configure your key store details and select Next.
- Select a build variant:
- If your
minSdkVersion
is 23 or earlier, select V1 (Jar Signature). We recommend also selecting V2 (Full APK Signature). - If your
minSdkVersion
is later than 23, we recommend selecting V2 (Full APK Signature).
- If your
- Select Finish.
For more details, see the Android APK signing documentation.
Upload your apps
To manage Android apps in your Customer Area, you must have the following user role:
- Merchant POS Terminal Management Admin role
After you have prepared the APK file:
- In your Customer Area, go to In-person payments > Android and select the Apps tab.
- Select Upload app.
If you do not see the Upload app button, contact our Support Team to enable it.
- In the dialog box:
- Drag the APK file to the upload box or select the box and choose the APK file.
- Optionally, enter a description of the app so that we can store this in our systems.
On the terminal, we will use the app name that is included in the APK. - Select the checkbox to opt in.
- Select Upload app.
- Stay on the page until the dialog box closes.
On the Android page, the Apps tab now shows the icon and APK name of your app. -
Check the status of your app.
Status Description Processing We are busy signing and converting the app. This can take up to an hour. Error Something went wrong. Check that the app matches the specifications and retry uploading the APK file. If the retry attempt fails as well, contact our Support Team or your Adyen implementation manager. Invalid There is something wrong with the APK file. Contact our Support Team or your Adyen implementation manager. Ready We finished signing and converting the app. The app is ready for installation.
(Optional) Upload the certificate
Some apps need a digital certificate. For example, a certificate to protect network communications between a POS app and the back end of that app. Such a certificate needs to be installed on the terminal, and replaced with a new one before the validity period of the certificate expires.
To manage Android apps and Android certificates in your Customer Area, you must have the following user role:
- Merchant POS Terminal Management Admin role
- Make sure that you have the certificate in .pem or .cert format.
- In your Customer Area, go to In-person payments > Android and select the Certificates tab.
- Select Upload new certificate.
- In the dialog box:
- Drag the certificate file to the upload box or select the box and choose the certificate file.
- Enter the certificate name to show in the Customer Area.
- Optionally, enter a description of the certificate.
- Select Upload certificate.
- Check that the Certificates tab now shows the name of your certificate, and the status Ready.